(Documentation Tips): Recommend against `iff'.
authorGlenn Morris <rgm@gnu.org>
Wed, 8 Aug 2007 07:56:45 +0000 (07:56 +0000)
committerGlenn Morris <rgm@gnu.org>
Wed, 8 Aug 2007 07:56:45 +0000 (07:56 +0000)
lispref/tips.texi

index de590c4cf9d28606bbce71af983fb44563a5faea..f3070f4659b17f63815068af8d99211db284cfc4 100644 (file)
@@ -844,6 +844,12 @@ Avoid using the word ``cause'' (or its equivalents) unnecessarily.
 Instead of, ``Cause Emacs to display text in boldface,'' write just
 ``Display text in boldface.''
 
+@item
+Avoid using ``iff'' (a mathematics term meaning ``if and only if''),
+since many people are unfamiliar with it and mistake it for a typo.  In
+most cases, the meaning is clear with just ``if''.  Otherwise, try to
+find an alternate phrasing that conveys the meaning.
+
 @item
 When a command is meaningful only in a certain mode or situation,
 do mention that in the documentation string.  For example,